/* 
 * [New BSD License (BSD 3-Clause License)]
 * Copyright (c) 2012, Max Bechtold
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *     - Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     - Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     - Neither the name of the Rel2Xml Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package maxbe.rel2xml.generator.dml;

import maxbe.rel2xml.generator.Column;
import maxbe.rel2xml.generator.Table;

/**
 * This class wraps an instance of type @link{Column} in order to connect it
 * with the entity it belongs to.
 * 
 * @author Max Bechtold
 * 
 */
public class ResultColumn {

	/** Column that this ResultColumn represents */
	private Column column;

	/** Entity this ResultColumn belongs to */
	private Entity entity;

	/**
	 * If this ResultColumn is used in the order clause to impose order on the
	 * result, this field states the kind of ordering
	 */
	private boolean orderedAscendant;

	public ResultColumn(Column column, Entity entity) {
		this.column = column;
		this.entity = entity;
	}

	public ResultColumn(String name, Entity entity) {
		this.column = new Column(name, null, null, null);
		this.entity = entity;
	}

	public Entity getEntity() {
		return entity;
	}

	public String getName() {
		return column.getName();
	}

	public String getXmlName() {
		return column.getXmlName();
	}

	public Table getTable() {
		return column.getTable();
	}

	public Column getRefColumn() {
		return column.getRefColumn();
	}

	public boolean isImplicit() {
		return column.isImplicit();
	}

	public boolean isOrderedAscendant() {
		return orderedAscendant;
	}

	public Column getColumn() {
		return column;
	}

	public void setOrderedAscendant(boolean orderedAscendant) {
		this.orderedAscendant = orderedAscendant;
	}

	@Override
	public String toString() {
		return column.toString();
	}
}
